<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2011 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: NamedArgumentFormatter.html 689 2013-06-28 19:22:16Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.dellroad.stuff.string;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import java.util.ArrayList;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import java.util.Collections;<a name="line.11"></a>
<span class="sourceLineNo">012</span>import java.util.HashMap;<a name="line.12"></a>
<span class="sourceLineNo">013</span>import java.util.Map;<a name="line.13"></a>
<span class="sourceLineNo">014</span>import java.util.Set;<a name="line.14"></a>
<span class="sourceLineNo">015</span>import java.util.regex.Matcher;<a name="line.15"></a>
<span class="sourceLineNo">016</span>import java.util.regex.Pattern;<a name="line.16"></a>
<span class="sourceLineNo">017</span><a name="line.17"></a>
<span class="sourceLineNo">018</span>/**<a name="line.18"></a>
<span class="sourceLineNo">019</span> * Interpreter for printf-style formatting strings that identifies arguments using names rather than indicies.<a name="line.19"></a>
<span class="sourceLineNo">020</span> *<a name="line.20"></a>
<span class="sourceLineNo">021</span> * &lt;p&gt;<a name="line.21"></a>
<span class="sourceLineNo">022</span> * Works just like {@link java.util.Formatter} but arguments are specified using names instead of numbers.<a name="line.22"></a>
<span class="sourceLineNo">023</span> * A mapping from argument name to argument value must be provided during the format operation.<a name="line.23"></a>
<span class="sourceLineNo">024</span> * &lt;/p&gt;<a name="line.24"></a>
<span class="sourceLineNo">025</span> *<a name="line.25"></a>
<span class="sourceLineNo">026</span> * @since 1.0.64<a name="line.26"></a>
<span class="sourceLineNo">027</span> */<a name="line.27"></a>
<span class="sourceLineNo">028</span>public class NamedArgumentFormatter {<a name="line.28"></a>
<span class="sourceLineNo">029</span><a name="line.29"></a>
<span class="sourceLineNo">030</span>    private static final Pattern FORMAT_PARAM_PATTERN = Pattern.compile("%(\\w+)\\$");<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span>    /**<a name="line.32"></a>
<span class="sourceLineNo">033</span>     * The list of argument names in the order they are used. This is the inverse mapping of {@link #fieldMap}.<a name="line.33"></a>
<span class="sourceLineNo">034</span>     */<a name="line.34"></a>
<span class="sourceLineNo">035</span>    protected final ArrayList&lt;String&gt; fieldList = new ArrayList&lt;String&gt;();<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span>    /**<a name="line.37"></a>
<span class="sourceLineNo">038</span>     * Mapping from argument name to argument list index. This is the inverse mapping of {@link #fieldList}.<a name="line.38"></a>
<span class="sourceLineNo">039</span>     */<a name="line.39"></a>
<span class="sourceLineNo">040</span>    protected final HashMap&lt;String, Integer&gt; fieldMap = new HashMap&lt;String, Integer&gt;();<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span>    /**<a name="line.42"></a>
<span class="sourceLineNo">043</span>     * The original format string provided to the constructor.<a name="line.43"></a>
<span class="sourceLineNo">044</span>     */<a name="line.44"></a>
<span class="sourceLineNo">045</span>    protected final String originalFormat;<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span>    /**<a name="line.47"></a>
<span class="sourceLineNo">048</span>     * The modified format string containing indexes instead of argument names.<a name="line.48"></a>
<span class="sourceLineNo">049</span>     */<a name="line.49"></a>
<span class="sourceLineNo">050</span>    protected final String indexedFormat;<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span>    /**<a name="line.52"></a>
<span class="sourceLineNo">053</span>     * Constructor.<a name="line.53"></a>
<span class="sourceLineNo">054</span>     *<a name="line.54"></a>
<span class="sourceLineNo">055</span>     * @param format format string containing argument names instead of indicies<a name="line.55"></a>
<span class="sourceLineNo">056</span>     */<a name="line.56"></a>
<span class="sourceLineNo">057</span>    public NamedArgumentFormatter(final String format) {<a name="line.57"></a>
<span class="sourceLineNo">058</span>        Matcher matcher = FORMAT_PARAM_PATTERN.matcher(format);<a name="line.58"></a>
<span class="sourceLineNo">059</span>        StringBuilder buf = new StringBuilder();<a name="line.59"></a>
<span class="sourceLineNo">060</span>        for (int offset = 0; true; offset = matcher.end(1)) {<a name="line.60"></a>
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span>            // Find next conversion<a name="line.62"></a>
<span class="sourceLineNo">063</span>            if (!matcher.find(offset)) {<a name="line.63"></a>
<span class="sourceLineNo">064</span>                buf.append(format.substring(offset));<a name="line.64"></a>
<span class="sourceLineNo">065</span>                break;<a name="line.65"></a>
<span class="sourceLineNo">066</span>            }<a name="line.66"></a>
<span class="sourceLineNo">067</span><a name="line.67"></a>
<span class="sourceLineNo">068</span>            // Extract argument name<a name="line.68"></a>
<span class="sourceLineNo">069</span>            String fieldName = matcher.group(1);<a name="line.69"></a>
<span class="sourceLineNo">070</span><a name="line.70"></a>
<span class="sourceLineNo">071</span>            // If we haven't seen this argument name yet, assign it the next parameter index<a name="line.71"></a>
<span class="sourceLineNo">072</span>            Integer fieldIndex = this.fieldMap.get(fieldName);<a name="line.72"></a>
<span class="sourceLineNo">073</span>            if (fieldIndex == null) {<a name="line.73"></a>
<span class="sourceLineNo">074</span>                fieldIndex = this.fieldList.size();<a name="line.74"></a>
<span class="sourceLineNo">075</span>                this.fieldMap.put(fieldName, fieldIndex);<a name="line.75"></a>
<span class="sourceLineNo">076</span>                this.fieldList.add(fieldName);<a name="line.76"></a>
<span class="sourceLineNo">077</span>            }<a name="line.77"></a>
<span class="sourceLineNo">078</span><a name="line.78"></a>
<span class="sourceLineNo">079</span>            // Replace field name in format string with parameter index<a name="line.79"></a>
<span class="sourceLineNo">080</span>            buf.append(format.substring(offset, matcher.start(1)));<a name="line.80"></a>
<span class="sourceLineNo">081</span>            buf.append(fieldIndex + 1);<a name="line.81"></a>
<span class="sourceLineNo">082</span>        }<a name="line.82"></a>
<span class="sourceLineNo">083</span>        this.originalFormat = format;<a name="line.83"></a>
<span class="sourceLineNo">084</span>        this.indexedFormat = buf.toString();<a name="line.84"></a>
<span class="sourceLineNo">085</span>    }<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span>    /**<a name="line.87"></a>
<span class="sourceLineNo">088</span>     * Format the string using the given arguments.<a name="line.88"></a>
<span class="sourceLineNo">089</span>     *<a name="line.89"></a>
<span class="sourceLineNo">090</span>     * @param argMap mapping from argument name to argument value<a name="line.90"></a>
<span class="sourceLineNo">091</span>     * @throws IllegalFormatException if the format provided to the constructor contained illegal syntax<a name="line.91"></a>
<span class="sourceLineNo">092</span>     * @throws IllegalFormatException if an argument value is incompatible or missing (and null would be invalid)<a name="line.92"></a>
<span class="sourceLineNo">093</span>     */<a name="line.93"></a>
<span class="sourceLineNo">094</span>    public String format(Map&lt;String, Object&gt; argMap) {<a name="line.94"></a>
<span class="sourceLineNo">095</span><a name="line.95"></a>
<span class="sourceLineNo">096</span>        // Put values into format parameter array<a name="line.96"></a>
<span class="sourceLineNo">097</span>        ArrayList&lt;Object&gt; parameterList = new ArrayList&lt;Object&gt;(this.fieldList.size());<a name="line.97"></a>
<span class="sourceLineNo">098</span>        for (String fieldName : this.fieldList)<a name="line.98"></a>
<span class="sourceLineNo">099</span>            parameterList.add(argMap.get(fieldName));<a name="line.99"></a>
<span class="sourceLineNo">100</span><a name="line.100"></a>
<span class="sourceLineNo">101</span>        // Format string<a name="line.101"></a>
<span class="sourceLineNo">102</span>        return String.format(this.indexedFormat, parameterList.toArray());<a name="line.102"></a>
<span class="sourceLineNo">103</span>    }<a name="line.103"></a>
<span class="sourceLineNo">104</span><a name="line.104"></a>
<span class="sourceLineNo">105</span>    /**<a name="line.105"></a>
<span class="sourceLineNo">106</span>     * Get the original format string provided to the constructor.<a name="line.106"></a>
<span class="sourceLineNo">107</span>     */<a name="line.107"></a>
<span class="sourceLineNo">108</span>    public String getFormat() {<a name="line.108"></a>
<span class="sourceLineNo">109</span>        return this.originalFormat;<a name="line.109"></a>
<span class="sourceLineNo">110</span>    }<a name="line.110"></a>
<span class="sourceLineNo">111</span><a name="line.111"></a>
<span class="sourceLineNo">112</span>    /**<a name="line.112"></a>
<span class="sourceLineNo">113</span>     * Get the argument names found in the configured format string.<a name="line.113"></a>
<span class="sourceLineNo">114</span>     *<a name="line.114"></a>
<span class="sourceLineNo">115</span>     * @return argument names as a unmodifiable set<a name="line.115"></a>
<span class="sourceLineNo">116</span>     */<a name="line.116"></a>
<span class="sourceLineNo">117</span>    public Set&lt;String&gt; getArgumentNames() {<a name="line.117"></a>
<span class="sourceLineNo">118</span>        return Collections.unmodifiableSet(this.fieldMap.keySet());<a name="line.118"></a>
<span class="sourceLineNo">119</span>    }<a name="line.119"></a>
<span class="sourceLineNo">120</span>}<a name="line.120"></a>
<span class="sourceLineNo">121</span><a name="line.121"></a>




























































</pre>
</div>
</body>
</html>
